<?php

namespace sffi\WechatRobotPlug\api;

interface RobotApiInterface
{
    /**
     * 开启一个新的微信，并获取二维码
     */
    public function startNewRobot(): array;

    /**
     * 关闭打开的新微信
     */
    public function closeNewRobot(): array;

    /**
     * 获取微信登录时长
     * @param string $robotWxid 机器人微信ID
     */
    public function getRobotLoginTime(): array;

    /**
     * 获取机器人发消息数
     * @param string $robotWxid 机器人微信ID
     */
    public function getRobotSendTimes(): array;

    /**
     * 获取机器人收信数
     * @param string $robotWxid 机器人微信ID
     */
    public function getRobotRecieveTimes(): array;

    /**
     * 开启防撤回
     * @param string $robotWxid 机器人微信ID
     */
    public function openWithdraw(): array;

    /**
     * 关闭防撤回
     * @param string $robotWxid 机器人微信ID
     */
    public function closeWithdraw(): array;

    /**
     * 置顶会话框
     * @param string $robotWxid
     * @param string $toWxid 待置顶的好友ID、群ID、公众号ID
     */
    public function topContact(string $toWxid);

    /**
     * 取消置顶
     * @param string $robotWxid
     * @param string $toWxid 待取消置顶的好友ID、群ID、公众号ID
     */
    public function downContact(string $toWxid);

    /**
     * 退出微信
     * @param string $robotWxid 机器人微信ID
     */
    public function exitRobot(string $robotWxid): array;
}